<HTML>
<HEAD>
<TITLE>HELP - briefCmd.page</TITLE>
<script type="text/javascript">
  var relPathToCommmon = "../../common/";
  var relPathToHelpDir = "../../common/help/";
</script>
<script type="text/javascript" src="../../common/jsdyn.js" language="JavaScript"></script>
<script type="text/javascript" src="../../common/js.js" language="JavaScript"></script>
<script type="text/javascript" src="leftmenu.js" language="JavaScript"></script>
<script type="text/javascript">
  var toSearchPage     = "_search','../../search";
  Body1();
</script>
<div class="headerPage">HELP - briefCmd.page</div>
<div class="path"><a href="#" OnMouseOver="link('','../../index',this)" class="pathLink">Help</A><img src="../../common/path-arrow.gif" class="path-arrow"><a href="#" OnMouseOver="link('_dir','CommandReference0',this)" class="pathLink">Command Reference</A><img src="../../common/path-arrow.gif" class="path-arrow"><span class="pathNonLink">briefCmd.page</span></div>
<script type="text/javascript">
 Body2();
 BodyLeftMenuStart();
WriteLeftMenu("","","","");
 BodyLeftMenuEnd();
 Body3();
</script>
<span class="tabInActive"><a href="#" OnMouseOver="linkTab('_file','briefCmd_page0','_description',this)" class="tabLinkInActive">Description</a></span>
<span class="tabInActiveGrayout"><span class="tabLinkGrayout">Overview</span></span>
<span class="tabInActiveGrayout"><span class="tabLinkGrayout">Included files</span></span>
<span class="tabInActiveGrayout"><span class="tabLinkGrayout">Included by</span></span>
<span class="tabActive"><a href="#" OnMouseOver="linkTab('_file','briefCmd_page0','_source',this)" class="tabLinkActive">Source</a></span>
<script type="text/javascript">
 Body4();
</script>
<div class="contentAirTop"></div>
<pre class="codeExamples">
/**
\page briefCmd
!!! Designating a brief description section ( brief )
The brief description should give a first one line introduction to what the symbol 
is or does. It is parsed from the beginning of the comment block description, until 
the first full stop or line break, see HowToDocument::BriefAndDescription. The 
brief description is shown on lists (class, function, overview etc.) to give a 
first introduction to the symbol.

! \\brief command (only use in rare cases) 
The brief command is used to override this behavior and explicitly define a brief 
description. It is }#NOT#} intended to be used except for rare cases.
!Syntax
\code
\brief This is a brief description which spans several lines
of text. It continues until a blank line or until a new section command is encountered

So this is not part of the brief description....
\endcode
!Output
See HowToDocument::BriefCmd

\include section_commands.inc
\note This command is mainly provided for compatibility with Doxygen or in the 
      rare cases where you for some reason }need} to span the brief over several 
      lines.

*/
</pre><div class="contentAirBottom"></div>
<script type="text/javascript">
 Body5();
Statistics("","","","","");
 Body6();
SetPageTab('_file','_source');
</script>
